home *** CD-ROM | disk | FTP | other *** search
/ Workbench Design / WB Collection.iso / workbench werkzeuge / disk & file tools / catchdisk / english / documentation / catchdisk.guide (.txt) < prev    next >
Amigaguide Document  |  1996-04-07  |  18KB  |  300 lines

  1. @database CatchDisk.guide
  2. @remark $VER: CatchDisk.guide 1.20 (26.4.94) 
  3.  Alessandro Sala
  4. @node Main "CatchDisk: User Guide"
  5.  ------------------------------------------------------------------------------
  6.                        CatchDisk version 1.20 26-Apr-1994
  7.                       Copyright 
  8.  1994 By Alessandro Sala
  9.                             dedicated to Cristina
  10.                Requires AmigaOS v2.04 ( Kickstart v37 ) or later
  11.              and WBStart-Handler v1.4 or later (by Stefan Becker)
  12.  ------------------------------------------------------------------------------
  13.                                     Contents
  14.                         - @{"Legal info              " link legal}
  15.                         - @{"The distribution archive" link archive}
  16.                         - Introduction
  17.                             @{"What is CatchDisk ?   " link whatis}
  18.                             @{"Installation          " link install}
  19.                         - @{"Configuration and usage " link usage}
  20.                         - @{"Terminating CatchDisk   " link term}
  21.                         - @{"Contact Addresses       " link contact}
  22.                         - @{"Revision history        " link history}
  23.       ******************************************************************
  24.         PLEASE NOTE: My E-Mail address has changed. My new address is:
  25.       +----------------------------------------------------------------+
  26.       |                                                                |
  27.       |                         Alessandro Sala                        |
  28.       |                                                                |
  29.       |                   tser1500@cdc8g5.cdc.polimi.it                |
  30.       |                                                                |
  31.       +----------------------------------------------------------------+
  32. @endnode
  33. @node legal "Legal info"
  34.                                   ------------
  35.                                    Disclaimer
  36.                                   ------------
  37.    This program is provided "as is" without warranty of any kind, either
  38. expressed or implied, including, but not limited to, the implied warranty
  39. of fitness for a particular purpose.  Though every care has been taken to
  40. make this program system-friendly and bugs-free, the entire risk as to the
  41. results, reliability and performance of this program is assumed by you.
  42.                                ------------------
  43.                                 Copyright notice
  44.                                ------------------
  45.    This program is "FreeWare": it can be freely copied and distributed for
  46. non-commercial purposes, provided that no file is added to or removed from the
  47. distribution archive and no charge, beside a nominal fee, is requested.
  48.    Fred Fish is, of course, explicitly allowed to put this program on his
  49. great disk library and/or on his CD-ROMs.
  50.    Nevertheless the program remains COPYRIGHT of the Author: you cannot
  51. patch, reverse engineer or otherwise modify the program, the documentation and
  52. every other file found in the distribution archive except where explicitly
  53. allowed.
  54.    Compressing in executable form is allowed for personal use but not
  55. for distribution. The only two allowed forms of distribution are the original
  56. lharc'ed archive or a uncompresssed form of it.
  57.    Furthermore you cannot embed the program in any other software without
  58. the written permission of the author.
  59. @endnode
  60. @node archive "The distribution archive"
  61.                       ------------------------------------
  62.                       Contents of the distribution archive
  63.                       ------------------------------------
  64.     CatchDisk           : The main program
  65.     CatchDisk.info      : Related '.info' file with pre-set tooltypes
  66.     Italiano
  67.       Leggimi           : General information in italian language
  68.       Documentazione
  69.         CatchDisk.doc   : Italian documentation in ASCII format
  70.         CatchDisk.guide : Italian documentation in AmigaGuide format
  71.       Installa          : Installation program in italian language (see Leggimi)
  72.     English
  73.       Readme            : General information in English language
  74.       Documentation
  75.         CatchDisk.doc   : English documentation in ASCII format
  76.         CatchDisk.guide : English documentation in AmigaGuide format
  77.       Install           : Installation program in English language (see Readme)
  78.     Deutsch        ( translations by Jan-Claas Dirks )
  79.       Liesmich          : General information in German language
  80.       Dokumentation
  81.         CatchDisk.dok   : German documentation in ASCII format
  82.         CatchDisk.guide : German documentation in AmigaGuide format
  83.       Install           : Installation program in German language (see Readme)
  84.     Catalogs
  85.       CatchDisk.ct        : Empty translation file
  86.       italiano
  87.         CatchDisk.catalog : Italian language support file
  88.       deutsch
  89.         CatchDisk.catalog : German language support file (by Jan-Claas Dirks)
  90.     Various '.info' files
  91. @endnode
  92. @node whatis "Introduction"
  93.                                What is CatchDisk ?
  94.                                ------------------
  95. CatchDisk is a simple commodity: its purpose is to detect when a new disk
  96. is inserted in any drive and check if it is properly formatted: if not,
  97. CatchDisk executes the Format program with the drive, in which the disk was
  98. inserted, already selected. The user has only to choose the format options and
  99. start or abort the operation. Besides, from v1.20 CatchDisk can recognize
  100. various non-DOS disks and ignore them, or run a user-chosen program when they
  101. are inserted. For more info and other features, read on.
  102.                                    IMPORTANT
  103.                                    ---------
  104. To use CatchDisk you must have the WBStart-Handler in you L: directory. You
  105. NEED VERSION 1.4 OR LATER of the handler. WBStart-Handler is a freely
  106. distributable software by Stefan Becker: you can find it as 'WBStart1_4.lha'
  107. in many FTP sites or from PD distributors. Please note that the version
  108. required is at least v1.4, because previous versions had problems when dealing
  109. with null locks.
  110. @endnode
  111. @node install "Introduction"
  112.                                   Installation
  113.                                   ------------
  114.    To install CatchDisk, if you have the 'Installer' utility from Commodore (see
  115. @{"'Readme'" link "/Readme/main"}), you can simply double-click the 'Install' icon found in the 'English'
  116. drawer.
  117.    Differently, you can simply copy CatchDisk in some drawer, typically
  118. your SYS:WBStartup drawer. If you have OS 2.1 or later and you want to
  119. take advantage of localization, you must also copy the 'catalogs' drawer, found
  120. in the CatchDisk distribution archive, into the same drawer as CatchDisk, or
  121. you can copy the 'CatchDisk.catalog' file ( found in the 'catalogs/<language>/'
  122. drawer ) into your 'LOCALE:catalogs/<language>/' drawer.
  123.    If your language is not currently available, you can fill in the empty
  124. translation file found in the catalogs drawer ( catalogs/CatchDisk.ct ) and
  125. send it to me by E-Mail ( see the @{"Contact Addresses" link contact} section ). I will
  126. create a new '<your-language>/CatchDisk.catalog' file and E-Mail it to you as
  127. soon as possible, and the next version of CatchDisk will support one more
  128. language. You can also translate the documentation files and send them to me
  129. for inclusion in the distribution of CatchDisk.
  130. You must also have WBStart-Handler in you L: directory for CatchDisk to work
  131. (see @{"'What is CatchDisk'" link whatis 14}.)
  132. @endnode
  133. @node usage "Configuration and usage"
  134.   To start CatchDisk simply double-click its icon or type 'run CatchDisk' from
  135. a CLI. To have it activated on every bootstrap, place it in your SYS:WBStartup
  136. drawer with the 'DONOTWAIT' tooltype, or insert 'run CatchDisk' in your
  137. S:user-startup file.
  138.   CatchDisk recognizes the following ToolTypes or CLI arguments:
  139.           CX_PRIORITY=<pri>     : The priority of CatchDisk in the commodities
  140.                                   network.
  141.                                   Default value = 0. Range = -128 to 127
  142.           DEVICE<n>=<drive>     : It describes a group of alternative drives
  143.                                     for a single physical drive.
  144.                                     The digit <n> identifies the group of
  145.                                     alternative drives, and can range from 0
  146.                                     to 9.
  147.                                     The <drive> parameter is the name of a
  148.                                     drive followed by ':', and you can list
  149.                                     any number of drives, without in-between
  150.                                     spaces.
  151.                                   Example:
  152.                                         'DEVICE0=DF0:PC0:'
  153.                                     tells CatchDisk that for a disk to be
  154.                                     considered properly formatted, it must be
  155.                                     readable accessing the drive as 'DF0:' or
  156.                                     as 'PC0:'.
  157.                                     If neither can read the disk, CatchDisk
  158.                                     will try to identify it from the first
  159.                                     4 bytes of track 0 (they are the 4
  160.                                     characters you can see under the Workbench
  161.                                     icon for the disk, after the DFx:). If
  162.                                     the disk is recognized, an action will be
  163.                                     taken, according to the @{"REQUESTER" link usage 111} and
  164.                                     @{"ID<x>" link usage 74} tooltypes, otherwise, according to 
  165.                                     the @{"REQUESTER" link usage 111} tooltype,  the @{"format program" link usage 68}
  166.                                     will be run on the first drive in the list
  167.                                     (in this example it will be DF0:).
  168.                                   If you specify instead:
  169.                                         'DEVICE0=PC0:DF0:'
  170.                                     if the disk in unreadable or not recognized
  171.                                     it will be formatted as 'PC0:'.
  172.                                   If one or more of the specified drives is not
  173.                                     mounted, it will be simply ignored.
  174.           BREAK_WARN            : When CatchDisk @{"terminates" link term} because of a
  175.                                   ^C signal, it displays a requester
  176.                                   informing you of the event only if BREAK_WARN
  177.                                   is set.
  178.           RESCAN=<secs>         : Forces CatchDisk to perform a new scan of all
  179.                                   devices every <secs> seconds. This allows
  180.                                   CatchDisk to detect the mounting of a device
  181.                                   that doesn't issue the 'diskinserted' message
  182.                                   (e.g. fake disks created with FMS).
  183.                                   Default value = 0 (no rescan).
  184.           FORMATTER=<path&file> : Allows to specify a format program
  185.                                   different from 'SYS:System/Format' which
  186.                                   is the default. You must specify the complete
  187.                                   path/filename.
  188.           ID<x>=<id>[,<name>[,<path&file>]] :
  189.                                   Describes a non-DOS disk format.
  190.                                   The digit <x> can range from 0 to 9: lower
  191.                                    numbers are checked first. 
  192.                                   <id> is a four-character identifier which
  193.                                     must match the first 4 bytes of
  194.                                     track 0 of a disk to identify it.
  195.                                     There are two special characters:
  196.                                         $ : Matches only a numeric digit (0-9)
  197.                                             or a '$'.
  198.                                         ? : Matches any character.
  199.                                     So, for example, Qb$$ matches any Quarterback
  200.                                     disk (Qb01, Qb02 etc.).
  201.                                   <name> is a text that will be used to tell 
  202.                                     the user what kind of disk CatchDisk has
  203.                                     identified. It will also be used as the label
  204.                                     for the middle gadget of the requester (see
  205.                                     below). If it is not given, the disk will
  206.                                     be always ignored, regardless of the
  207.                                     @{"REQUESTER" link usage 111} tooltype.
  208.                                   <file&path> is the path and filename of the
  209.                                     program to run when CatchDisk identifies
  210.                                     this disk format. This is the default
  211.                                     action which CatchDisk takes if @{"REQUESTER" link usage 111}
  212.                                     is NOID or NEVER. If <file&path> is not
  213.                                     given it defaults to the @{"format program" link usage 68}.
  214.                                   You can find some examples in CatchDisk's
  215.                                     icon.
  216.           REQUESTER=<when>      : Where <when> is NEVER, ID, NOID or ALWAYS.
  217.                                   When CatchDisk detects a non-DOS disk, it can
  218.                                     take a default action or it can open a
  219.                                     requester asking the user what action
  220.                                     to take.
  221.                                   For unreadable/unrecognized disks the
  222.                                     actions are 'Ignore' or 'Format', with the
  223.                                     default being 'Format'.
  224.                                   For recognized disks the actions are 'Ignore'
  225.                                     'Format' or 'run the user-program', as set
  226.                                      in the respective @{"ID<x>" link usage 74}
  227.                                      tooltype.  The default is to run the
  228.                                      user-program.                                
  229.                                   If <when>=NEVER, CatchDisk always proceeds
  230.                                     without asking the user, and takes the
  231.                                     default action (see above).
  232.                                   If <when>=ID, CatchDisk opens the requester
  233.                                     only for identified disks, otherwise it
  234.                                     takes the default action.
  235.                                   If <when>=NOID, CatchDisk opens the
  236.                                     requester only for unreadable/unrecognized
  237.                                     disks, otherwise it takes the default action.
  238.                                   If <when>=ALWAYS, CatchDisk always opens the
  239.                                     requester.
  240.    Once CatchDisk is active you can use the Commodities Exchange program to
  241. control its activities.
  242. @endnode
  243. @node term "Terminating CatchDisk"
  244. As a commodity, CatchDisk can be terminated in three ways:
  245.   a) Run CatchDisk a second time.
  246.   b) Use the Commodities Exchange program.
  247.   c) Send CatchDisk a 'control-C' signal (see also @{"BREAK_WARN" link usage 54}):
  248.     c.1) If you started CatchDisk from workbench (or WBStartup drawer) use a
  249.          task control utility such as TaskX by Steve Tibbet.
  250.     c.2) If you started CatchDisk from a CLI (or user-startup) do the following:
  251.           1) Open a CLI
  252.           2) Issue the 'STATUS' command and note the process number of CatchDisk
  253.           3) Issue 'BREAK <n> C' where <n> is the process number noted above
  254. @endnode
  255. @node contact "Contact Addresses"
  256.                            Criticism and suggestions
  257.                            -------------------------
  258.    I hope you will find CatchDisk useful, and if you have any criticism,
  259. suggestions, bug report, ideas for enhancements in possible future versions,
  260. or if you have problems using CatchDisk and need help, you can write ( in
  261. Italian or English ) to the following address:
  262.         Alessandro Sala
  263.         Via A. Grandi, 16
  264.         20014 Nerviano (MI)
  265.         Italy
  266.     If you have E-Mail capability you can also contact me at the following
  267. Internet (new) address (at least until the end of July, 1994):
  268.         tser1500@cdc8g5.cdc.polimi.it
  269. @endnode
  270. @node history "Revision history"
  271. **********************************************************************************
  272.                                     History
  273. **********************************************************************************
  274. ------------
  275. Version 1.20
  276. ------------
  277.     - Removed several bugs when more than one PCx: device is mounted (duplicated
  278.     format requests, format requests when removing a disk etc.). Problems in
  279.     detecting NDOS disks when a PCx: device is mounted should now be solved. 
  280.     - Added the ability to identify non-DOS disks (suggested by Jan-Claas
  281.     Dirks too) and take user-defined actions.
  282.     - Added optional requesters before any action is taken.
  283.     - Added the ability to run a user-defined format program.
  284.     - Added German language support (thanks to Jan-Claas Dirks).
  285. ------------
  286. Version 1.10
  287. ------------
  288.     - When you re-enable CatchDisk, after having disabled it using 'Exchange',
  289.     it now performs a new scan of the various devices to see if there is any
  290.     new disk to be formatted.
  291.     - Added the 'RESCAN=<secs>' tooltype which forces CatchDisk to perform a
  292.     new scan of all devices every <secs> seconds, in order to detect the
  293.     mounting of devices that don't issue a 'diskinserted' message, such as
  294.     FMS fake disks (reported by Frank Schliefer).
  295. ------------
  296. Version 1.00
  297. ------------
  298.      First release.
  299. @endnode
  300.